home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / off_09.zip / README.1ST < prev    next >
Text File  |  1993-01-12  |  6KB  |  139 lines
  1.                               OFF V.0.9.
  2.                         Vassilis Dimakopoulos
  3.                               Jan. 1993
  4.  
  5.  
  6.  
  7.  
  8. Read this file before using OFF for  the  first  time.  OFF  is  free,
  9. public domain. Use it and modify it (if you can :-)) as you wish.  You
  10. are NOT allowed however to sell it. Look at the end of this  file  for
  11. information about the source code.
  12.  
  13. You should have the following files:
  14.  
  15. off.exe      -   the OFF text formatter
  16. reader.off   -   info on the options and usage of OFF
  17. reader.txt   -   info on the options and usage of OFF (preformatted)
  18. writer.off   -   tutorial on the commands of OFF
  19. writer.txt   -   tutorial on the commands of OFF (preformatted)
  20. readme.1st   -   this file
  21.  
  22.  
  23. 1. About using OFF
  24.  
  25.     OFF acts as a filter: reads a text file and formats  it  according
  26. to simple commands that may exist in it. Normaly it sends  the  output
  27. directly to the screen, i.e. it acts also as  a  'previewer'.  If  you
  28. want to save the output to a file, or print it you  normally  have  to
  29. preview it for a couple of times to make sure everything looks the way
  30. it should. Then run OFF with one  of  the  '-a'  or  '-p'  options  to
  31. redirect the output to disk or printer.
  32.  
  33.     Consult the 'reader' files for the complete list  of  options  and
  34. the 'writer' files for the commands of OFF. You can also get a list of
  35. OFF's options by running OFF with no  parameters  at  all;  just  type
  36. 'off' at your MSDOS prompt.
  37.  
  38. IMPORTANT NOTE:
  39.  
  40.     OFF uses ANSI codes to produce screen output,  so  make  sure  you
  41. have one of the ANSI drivers available from many ftp sites.
  42.  
  43.  
  44. 2. The 'reader' and 'writer' files
  45.  
  46.     'reader.txt' is the next file you should consult after  this  one;
  47. you'll  understand  how  to  use  OFF  to  preview  and  print  files.
  48. 'writer.txt' is a tutorial on the formatting commands OFF understands;
  49. you'll need that when you actually want to have your  files  formatted
  50. by OFF.
  51.  
  52.     'reader.off' and 'writer.off' are the source files  that  resulted
  53. in 'reader.txt' and 'writer.txt' after OFF precessed them (actually  I
  54. edited them a bit after OFF  produced  the  result  so  they  are  not
  55. exactly what OFF would have produced). You can use  them  as  a  quick
  56. reference (by previewing them) plus you can see  the  usage  of  OFF's
  57. commands (especially in the 'writer.off' file where  some  non-trivial
  58. situations were met). After you feel sure  about  OFF's  usage  it  is
  59. better to let OFF print 'writer.off' instead of printing  'writer.txt'
  60. by yourself, since 'writer.off' can be matched to  your  printer  page
  61. size.
  62.  
  63.  
  64. 3. Directories
  65.  
  66.     If you want to keep a directory of all you documents so  that  you
  67. can take a look at them easily, you can set the environmental variable
  68. 'OFFPATH' to contain specific directories were  OFF  should  look  for
  69. source files. The additional  feature  of  OFF  not  needing  filename
  70. extensions to identify a file actually saves lots of time: I  use  OFF
  71. as a small unix-like 'man'  and  have  all  the  documents  about  the
  72. programs and utilities I've written in certain directories  where  OFF
  73. searches.
  74.  
  75.  
  76. 4. Printing
  77.  
  78.     You have to have a line printer to take advantage  of  the  direct
  79. printing capabilities of OFF. I DO NOT HAVE  ONE!  I  had  one  for  a
  80. couple of months only and wrote the driver code then. So i'm not  100%
  81. that it will work for every line printer!
  82.  
  83.     I usually produce plain ascii output, save it in a file,  transfer
  84. it to the Unix machines in our department and print it  in  the  laser
  85. printers  there.  I'm  not  into  PostScript  so  I   cannot   produce
  86. bold/underlined/etc. characters this way.
  87.  
  88.     I'm especially interested in making OFF produce PostScript code on
  89. request, so anybody interested in helping  me  please  do  so  ...  In
  90. return I'll share the source code of OFF with  you  and  you'll  be  a
  91. co-author in the later versions of OFF.
  92.  
  93.  
  94. 5. Screen Ouput
  95.  
  96.     On my ancient XT a fast ANSI driver makes a hell of a  difference.
  97. I guess that a >= 286 machine will have no speed  problems  no  matter
  98. how fast the ANSI driver is. OFF is relatively fast since each line of
  99. the output is processed in memory first before actually being printed.
  100. The word-by-word approach used in previous versions  was  considerably
  101. slower. I imagine that a page-by-page approach may be even faster  but
  102. I don't think it is needed.
  103.  
  104.     Finally, OFF was not meant to be a screen previewer that's  why  I
  105. did not implement backward movement functions (like page up). One  can
  106. only move forward when viewing a file.  The  backward  moves  are  not
  107. trivial to implement, so if nobody complains there are chances of them
  108. never being implemented.
  109.  
  110.  
  111. 6. Unix
  112.  
  113.     An almost-working version of OFF runs on  Unix  machines.  Anybody
  114. interested in making it actually-working, let me know.
  115.  
  116.  
  117. 7. Bugs, author info.
  118.  
  119.     There MUST be some bugs although I spent a  considerable  time  of
  120. pushing the usage of OFF to the limmit.  Some  minor  bugs  seemed  so
  121. minor and so unlikely to ever come across so I did not even bother  to
  122. fix them. I'm interested, though, in making OFF better than it is  and
  123. let everybody enjoy a bug-free program, so report any problems to  me.
  124. If you have any suggestions for improving OFF let me know.
  125.  
  126.     The source code is NOT free, actually it is worth  $30.  The  only
  127. exception is for the ones willing to contibute  a  major  addition  to
  128. OFF's features. I'm particularly interested in PostScript  output  and
  129. code for backward movement when  previewing  a  file  (these  are  the
  130. 'major additions') since I do not have the time to do them myself.
  131.  
  132.  
  133. I am:
  134.  
  135. Vassilis Dimakopoulos
  136. Elec & Comp Engineering, University of Victoria
  137. dimako@sirius.uvic.ca
  138.  
  139.